<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>spade.xmpp.commands.TestCommand</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spade2.googlecode.com">SPADE</a></th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="spade-module.html">Package&nbsp;spade</a> ::
        <a href="spade.xmpp-module.html">Package&nbsp;xmpp</a> ::
        <a href="spade.xmpp.commands-module.html">Module&nbsp;commands</a> ::
        Class&nbsp;TestCommand
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="spade.xmpp.commands.TestCommand-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class TestCommand</h1><p class="nomargin-top"><span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand">source&nbsp;code</a></span></p>
<center>
<center>  <map id="uml_class_diagram_for_spade_xm_13" name="uml_class_diagram_for_spade_xm_13">
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#name" title="spade.xmpp.commands.TestCommand.name" alt="" coords="17,311,277,329"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#description" title="spade.xmpp.commands.TestCommand.description" alt="" coords="17,329,277,348"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#__init__" title="Init internal constants." alt="" coords="17,351,277,369"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#cmdFirstStage" title="Determine" alt="" coords="17,369,277,388"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#cmdSecondStage" title="spade.xmpp.commands.TestCommand.cmdSecondStage" alt="" coords="17,388,277,407"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#cmdSecondStageReply" title="spade.xmpp.commands.TestCommand.cmdSecondStageReply" alt="" coords="17,407,277,425"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#cmdThirdStage" title="spade.xmpp.commands.TestCommand.cmdThirdStage" alt="" coords="17,425,277,444"/>
<area shape="rect" id="node2507" href="spade.xmpp.commands.TestCommand-class.html#cmdCancel" title="spade.xmpp.commands.TestCommand.cmdCancel" alt="" coords="17,444,277,463"/>
<area shape="rect" id="node1" href="spade.xmpp.commands.TestCommand-class.html" title="Example class." alt="" coords="5,286,288,469"/>
<area shape="rect" id="node2508" href="spade.xmpp.commands.Command_Handler_Prototype-class.html#count" title="spade.xmpp.commands.Command_Handler_Prototype.count" alt="" coords="59,145,236,164"/>
<area shape="rect" id="node2508" href="spade.xmpp.commands.Command_Handler_Prototype-class.html#discofeatures" title="spade.xmpp.commands.Command_Handler_Prototype.discofeatures" alt="" coords="59,164,236,183"/>
<area shape="rect" id="node2508" href="spade.xmpp.commands.Command_Handler_Prototype-class.html#plugin" title="Plug command into the commands class" alt="" coords="59,185,236,204"/>
<area shape="rect" id="node2508" href="spade.xmpp.commands.Command_Handler_Prototype-class.html#plugout" title="Remove command from the commands class" alt="" coords="59,204,236,223"/>
<area shape="rect" id="node2508" href="spade.xmpp.commands.Command_Handler_Prototype-class.html#getSessionID" title="Returns an id for the command session" alt="" coords="59,223,236,241"/>
<area shape="rect" id="node2508" href="spade.xmpp.commands.Command_Handler_Prototype-class.html#Execute" title="The method that handles all the commands, and routes them to the correct &#160;method for that stage." alt="" coords="59,241,236,260"/>
<area shape="rect" id="node2" href="spade.xmpp.commands.Command_Handler_Prototype-class.html" title="This is a prototype command handler, as each command uses a disco method and execute method you can implement it any way you like, however this is my first attempt at making a generic handler that you can hang process stages on too." alt="" coords="47,121,247,266"/>
<area shape="rect" id="node2509" href="spade.xmpp.client.PlugIn-class.html#DEBUG" title="Feed a provided debug line to main instance&#39;s debug facility along with our ID string." alt="" coords="45,39,249,57"/>
<area shape="rect" id="node2509" href="spade.xmpp.client.PlugIn-class.html#PlugIn" title="Attach to main instance and register ourself and all our staff in it." alt="" coords="45,57,249,76"/>
<area shape="rect" id="node2509" href="spade.xmpp.client.PlugIn-class.html#PlugOut" title="Unregister all our staff from main instance and detach from it." alt="" coords="45,76,249,95"/>
<area shape="rect" id="node3" href="spade.xmpp.client.PlugIn-class.html" title="Common xmpppy plugins infrastructure: plugging in/out, debugging." alt="" coords="33,6,260,101"/>
</map>
  <img src="uml_class_diagram_for_spade_xm_13.gif" alt='' usemap="#uml_class_diagram_for_spade_xm_13" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Example class. You should read source if you wish to understate how it
  works. Generally, it presents a &quot;master&quot; that giudes user 
  through to calculate something.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="spade.xmpp.commands.TestCommand-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">jid</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span><br />
      Init internal constants.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cmdFirstStage"></a><span class="summary-sig-name">cmdFirstStage</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">conn</span>,
        <span class="summary-sig-arg">request</span>)</span><br />
      Determine</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.cmdFirstStage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cmdSecondStage"></a><span class="summary-sig-name">cmdSecondStage</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">conn</span>,
        <span class="summary-sig-arg">request</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.cmdSecondStage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cmdSecondStageReply"></a><span class="summary-sig-name">cmdSecondStageReply</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">conn</span>,
        <span class="summary-sig-arg">request</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.cmdSecondStageReply">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cmdThirdStage"></a><span class="summary-sig-name">cmdThirdStage</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">conn</span>,
        <span class="summary-sig-arg">request</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.cmdThirdStage">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="cmdCancel"></a><span class="summary-sig-name">cmdCancel</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">conn</span>,
        <span class="summary-sig-arg">request</span>)</span></td>
          <td align="right" valign="top">
            <span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.cmdCancel">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html">Command_Handler_Prototype</a></code></b>:
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#Execute">Execute</a></code>,
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#getSessionID">getSessionID</a></code>,
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#plugin">plugin</a></code>,
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#plugout">plugout</a></code>
      </p>
    <div class="private">    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html">Command_Handler_Prototype</a></code></b> (private):
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#_DiscoHandler" onclick="show_private();">_DiscoHandler</a></code>
      </p></div>
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.xmpp.client.PlugIn-class.html">client.PlugIn</a></code></b>:
      <code><a href="spade.xmpp.client.PlugIn-class.html#DEBUG">DEBUG</a></code>,
      <code><a href="spade.xmpp.client.PlugIn-class.html#PlugIn">PlugIn</a></code>,
      <code><a href="spade.xmpp.client.PlugIn-class.html#PlugOut">PlugOut</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="name"></a><span class="summary-name">name</span> = <code title="'testcommand'"><code class="variable-quote">'</code><code class="variable-string">testcommand</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="description"></a><span class="summary-name">description</span> = <code title="'a noddy example command'"><code class="variable-quote">'</code><code class="variable-string">a noddy example command</code><code class="variable-quote">'</code></code>
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html">Command_Handler_Prototype</a></code></b>:
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#count">count</a></code>,
      <code><a href="spade.xmpp.commands.Command_Handler_Prototype-class.html#discofeatures">discofeatures</a></code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">jid</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="spade.xmpp.commands-pysrc.html#TestCommand.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Init internal constants.</p>
  <dl class="fields">
    <dt>Overrides:
        <a href="spade.xmpp.client.PlugIn-class.html#__init__">client.PlugIn.__init__</a>
    </dt>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="spade-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            ><a class="navbar" target="_top" href="http://spade2.googlecode.com">SPADE</a></th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Wed Aug  1 18:44:57 2012
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
